/*

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements.  See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership.  The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License.  You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.bff.gaia.unified.sdk.metrics;



import com.google.auto.value.AutoValue;

import com.bff.gaia.unified.sdk.annotations.Experimental;

import com.bff.gaia.unified.sdk.annotations.Experimental.Kind;

import com.bff.gaia.unified.vendor.guava.com.google.common.base.Strings;



import java.io.Serializable;



import static com.bff.gaia.unified.vendor.guava.com.google.common.base.Preconditions.checkArgument;



/**

 * The name of a metric consists of a {@link #getNamespace} and a {@link #getName}. The {@link

 * #getNamespace} allows grouping related metrics together and also prevents collisions between

 * multiple metrics with the same name.

 */

@Experimental(Kind.METRICS)

@AutoValue

public abstract class MetricName implements Serializable {



  /** The namespace associated with this metric. */

  public abstract String getNamespace();



  /**

   * The namespace associated with this metric.

   *

   * @deprecated to be removed once Dataflow no longer requires this method.

   */

  @Deprecated

  public String namespace() {

    return getNamespace();

  }



  /** The name of this metric. */

  public abstract String getName();



  @Override

  public String toString() {

    return String.format("%s:%s", getNamespace(), getName());

  }



  /**

   * The name of this metric.

   *

   * @deprecated to be removed once Dataflow no longer requires this method.

   */

  @Deprecated

  public String name() {

    return getName();

  }



  public static MetricName named(String namespace, String name) {

    checkArgument(!Strings.isNullOrEmpty(namespace), "Metric namespace must be non-empty");

    checkArgument(!Strings.isNullOrEmpty(name), "Metric name must be non-empty");

    return new AutoValue_MetricName(namespace, name);

  }



  public static MetricName named(Class<?> namespace, String name) {

    checkArgument(namespace != null, "Metric namespace must be non-null");

    checkArgument(!Strings.isNullOrEmpty(name), "Metric name must be non-empty");

    return new AutoValue_MetricName(namespace.getName(), name);

  }

}